Get the transcript of an assist bot

This endpoint retrieves the conversation flow that one assist bot saw on a call. An assist bot listens to a live conversation, so its flow is separate from the call's own. Fetch that with Get the transcript of a call.

Endpoint

GET /api/v1/calls/{callId}/agentAssistBots/{botId}/conversationFlow

Path parameters

Parameter Type Description
callId string UUID of the call.
botId string UUID of the assist bot.

Query parameters

Parameter Type Description
type array Optional. Which message types to include. Repeat the parameter once per type, as in ?type=dialog&type=metadata. Omit it and every type is included.
isSimpleCallTranscript boolean Whether to return a simple transcript rather than the full one.

type takes these values:

Value What it includes
dialog Text spoken by both sides of the conversation.
system System events, such as conversation start and call end.
control Control events to and from the bot, such as configuration updates.
rawBot Every event to and from the bot, in raw form.
metadata Metadata events sent from the bot to the agent application, for agent assist.

Request

GET /api/v1/calls/44510fc4-5745-87cd-847d-019a1178bf1c/agentAssistBots/c06a5844-b0f3-4413-9488-ce801b5dff8d/conversationFlow?isSimpleCallTranscript=true HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — a JSON object whose root is conversationFlow. Dialog messages from the customer also carry recognitionOutput, the speech-to-text result behind the text, including the alternatives the recognizer considered.

{
  "conversationFlow": [
    {
      "timestamp": "2025-10-23T14:28:32.305Z",
      "type": "dialogMessage",
      "dialogMessage": {
        "message": "Hello this is audio codes mockbot.",
        "side": "Client",
        "sttDelayMs": 711,
        "turnId": "dbcf7b84-893e-4e03-a717-2f4e964e99f4",
        "participant": "customer",
        "recognitionOutput": {
          "confidence": 0.56634974,
          "recognitionOutput": {
            "Id": "967717e122e44db1aad8891b282b771c",
            "RecognitionStatus": "Success",
            "Offset": 6900000,
            "Duration": 23600000,
            "Channel": 0,
            "DisplayText": "Hello this is audio codes mockbot.",
            "NBest": [
              {
                "Confidence": 0.56634974,
                "Lexical": "hello this is audio codes mockbot",
                "ITN": "hello this is audio codes mockbot",
                "MaskedITN": "hello this is audio codes mockbot",
                "Display": "Hello this is audio codes mockbot."
              },
              {
                "Confidence": 0.49557936,
                "Lexical": "hello this is audio codes mock bot",
                "ITN": "hello this is audio codes mock bot",
                "MaskedITN": "hello this is audio codes mock bot",
                "Display": "hello this is audio codes mock bot"
              },
              {
                "Confidence": 0.5538523,
                "Lexical": "hello this is audiocodes mockbot",
                "ITN": "hello this is audiocodes mockbot",
                "MaskedITN": "hello this is audiocodes mockbot",
                "Display": "hello this is audiocodes mockbot"
              }
            ]
          },
          "text": "Hello this is audio codes mockbot.",
          "utteranceEndOffset": 3050,
          "participant": "customer",
          "participantUriUser": "anonymous",
          "turnId": "dbcf7b84-893e-4e03-a717-2f4e964e99f4"
        }
      }
    }
  ]
}